Update contribution guide
authorMatthias Clasen <mclasen@redhat.com>
Sat, 5 Dec 2020 16:34:52 +0000 (11:34 -0500)
committerMatthias Clasen <mclasen@redhat.com>
Sat, 5 Dec 2020 16:34:52 +0000 (11:34 -0500)
Make my feelings about bug reporting by screencast known.

CONTRIBUTING.md

index 474598fc81baebadfd9d59ad1f5819b5c4b8d813..80be9420fcc55505be63b6e294b586d6b97947ed 100644 (file)
@@ -56,6 +56,12 @@ If the issue includes a crash, you should also include:
  0. the eventual warnings printed on the terminal
  0. a backtrace, obtained with tools such as GDB or LLDB
 
+It is fine to include screenshots of screen recordings to demonstrate
+an issue that is best to understand visually, but please don't just
+dump screen recordings without further details into issues. It is
+essential that the problem is described in enough detail to reproduce
+it without watching a video.
+
 For small issues, such as:
 
  - spelling/grammar fixes in the documentation